home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr35 / famr110.zip / FAMROB.DOC < prev    next >
Text File  |  1993-01-27  |  5KB  |  179 lines
  1.   FAMROB - File Attach Message ROBot
  2.   ----------------------------------
  3.  
  4.  
  5.   Stefan Elf, SM2LCI
  6.   SElfMade Software, Copyright (C) Stefan Elf, SM2LCI, 1992
  7.   All Rights Reserved
  8.  
  9.  
  10.   -----------------------------------------------------------------
  11.  
  12.   Please read the file LICENSE.DOC
  13.  
  14.   -----------------------------------------------------------------
  15.  
  16.  
  17.   WHAT IS FAMROB?
  18.   --------------
  19.  
  20.   FAMROB is an acronym for 'File Attach Message ROBot'. Hence, it is
  21.   a program which may be used to automate file transfer between fido-
  22.   mail systems.
  23.  
  24.   There is really nothing more to it!
  25.  
  26.   There is an unregistered and a registered version of FAMROB. It
  27.   ia ONLY THE UNREGISTERED VERSION THAT MAY BE DISTRIBUTED by
  28.   others than the author.
  29.  
  30.   Without a valid registration key, FAMROB will have one limitation.
  31.   It is, then, not possible to have another message that the standard
  32.   one that accompanies the distribution, which states that it is an
  33.   evaluation version.
  34.  
  35.   FAMROB is probably best described by studying the configuration
  36.   file, so lets do just that.
  37.   
  38.  
  39.   THE CONFIGURATION FILE - FAMROB.CNF
  40.   -----------------------------------
  41.  
  42.   The configuration file lets the user set data pertaining to the
  43.   files to send and the message to include.
  44.  
  45.   SCAN_DIR=[[<drive>:][<path>]]
  46.  
  47.     The directory to scan for files to send.
  48.  
  49.     Default: The current directory (when executing FAMROB i.e.)
  50.  
  51.   SCAN_PATTERN=<pattern>
  52.  
  53.     The file name pattern to use when scanning SCAN_DIR.
  54.  
  55.     Default: The default is all files, "*.*"
  56.  
  57.   MESSAGE_DIR=[[<drive>:][<path>]]
  58.  
  59.     The directory which contains the nnn.msg files for netmail.
  60.     NB! this program assumes that netmail messages are stored in
  61.     Fido format.
  62.  
  63.     Default: No default, must be present
  64.  
  65.   LETTER_FILE=[[<drive>:][<path>]]<file_name>
  66.  
  67.     The file which contains a text to accompany every file attached
  68.     message. If you are running an unregistered version, the only
  69.     file that is accepted by FAMROB, is the supplied test file
  70.     FAMROB.MSG. If you have registered the software, you may use any
  71.     name and any contents (which must be less than 8 KB in length,
  72.     including the file name list added by FAMROB).
  73.  
  74.     Default: FAMROB.MSG (any contents if registered)
  75.  
  76.   ADD_FILELIST={Yes|No}
  77.  
  78.     If Yes, a list of the attached files, names and sizes, will be
  79.     added to the end of the message.
  80.  
  81.     Default: No
  82.  
  83.   LOG_FILE=[[<drive>:][<path>]]<file_name>
  84.  
  85.     The name of the log file to which the names and sizes of all
  86.     files that have been file attached are written. When a new
  87.     file is to be attached to a message, this file will first be
  88.     searched, to ensure that the file has not already been sent.
  89.     (Since it takes some time to search the log file, is might be
  90.     a good idea to shorten it, or delete it now and then).
  91.  
  92.     Default: FAMROB.LOG (in the same directory as the executable)
  93.  
  94.   DBRIDGE_DIR=[[<drive>:][<path>]]
  95.  
  96.     The path to the root directory of D'BRIDGE.
  97.  
  98.     Default: No default, must be present if INIT_SCAN is set to Yes.
  99.  
  100.   INIT_SCAN={Yes|No}
  101.  
  102.     If Yes, FAMROB will create a file in the D'BRIDGE root directory,
  103.     pointed to by DBRIDGE_DIRECTORY, that will cause D'BRIDGE to
  104.     rescan netmail upon its restart.
  105.  
  106.     Default: No
  107.  
  108.   PRIORITY={HOLD|NORMAL|CRASH}
  109.  
  110.     This is the priority that will be assigned to the created netmail
  111.     messages.
  112.  
  113.     Default: NORMAL
  114.  
  115.   FROM_USER_NAME=<The sender's name>
  116.  
  117.     The name of the sender.
  118.  
  119.     Default: The default name is "FAMROB <versionNumber>"
  120.  
  121.   FROM_ADDRESS=[<zone>]:<net>/<node>[.<point>]
  122.  
  123.     The fidonet address of the sender.
  124.  
  125.     Default: No default, must be present.
  126.  
  127.   TO_USER_NAME=<The receiver's name>
  128.  
  129.     The name of the receiver. There may be several TO_USER_NAME/
  130.     TO_ADDRESS pairs.
  131.  
  132.     Default: The default name is "System operator"
  133.  
  134.   TO_ADDRESS=[<zone>]:<net>/<node>[.<point>]
  135.  
  136.     The fidonet address of the receiver. There may be several
  137.     TO_USER_NAME/ TO_ADDRESS pairs.
  138.  
  139.     Default: No default, must be present.
  140.  
  141.  
  142.   INSTALLATION
  143.   ------------
  144.  
  145.   There is not much to the installation of FAMROB. Just create a
  146.   directory in which you would like FAMROB to reside. Copy the
  147.   files from the root directory of the distribution diskette to
  148.   this directory. Alternatively, unpack the archive containing
  149.   FAMROB in the directory, where you wish FAMROB to reside.
  150.  
  151.   Registration key
  152.   ----------------
  153.  
  154.   A valid registration key, if you have one, goes in the file
  155.   FAMROB.KEY, which must be located in the same directory as the
  156.   FAMROB.EXE file.
  157.  
  158.  
  159.   TO RUN FAMROB
  160.   -------------
  161.  
  162.   Just set up the configuration file to your needs, put all FAMROB
  163.   files in the same directory.
  164.  
  165.   Then
  166.  
  167.   * Move to the directory from which you wish to start executing
  168.   * Invoke FAMROB.EXE
  169.  
  170.   Example:
  171.  
  172.   You have put the program files in C:\FAMROB. You wish to start
  173.   the program while you are in the C:\RA\UPLOADS\PC directory.
  174.  
  175.   c:
  176.   cd \ra\uploads\pc
  177.   c:\FAMROB\FAMROB.exe
  178.  
  179.